home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / archiver / xchg_103.zip / XCHANGE.DOC < prev    next >
Text File  |  1989-03-20  |  7KB  |  196 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                  XChange V1.03
  8.  
  9.                            Program and Documentation
  10.                                  Copyright 1989
  11.                                   Scott Samet
  12.                                    1:135/990
  13.  
  14.      It seems that each week brings a new and better file compression
  15.      utility.  XChange allows you to automate the conversion from one
  16.      compression system to another.  It can be used for a one-time
  17.      conversion of an entire collection, or as a periodic procedure to
  18.      convert new uploads.
  19.  
  20.      While there are already batch files and simple programs to accomplish
  21.      this task, XChange has a number of advantages:
  22.  
  23.           o  NESTED FILES - It's common for a compressed file to
  24.              contain compressed files as members.  XChange will (upon
  25.              request) convert nested files.
  26.  
  27.           o  WILDCARDS - XChange accepts wildcards and will convert
  28.              entire groups of files in a single run.
  29.  
  30.           o  SUBDIRECTORIES - On request, XChange will search
  31.              subdirectories (to any depth) and convert every file it
  32.              encounters.  By pointing XChange to the root directory
  33.              and requesting subdirectory processing, it will convert
  34.              an entire volume.
  35.  
  36.           o  NATIVE UTILITIES - XChange invokes your standard packing
  37.              and unpacking utilities for each format.  You aren't
  38.              depending upon unfamiliar programs to convert your files.
  39.  
  40.           o  EXTENSIBLE - A configuration file allows you to tailor
  41.              XChange so it supports compression methods that haven't
  42.              even been written yet.
  43.  
  44.           o  ERROR CHECKING - XChange checks the error codes for each
  45.              step.  Errors will be logged and XChange will process the
  46.              next input file.
  47.  
  48.  
  49.                                     WARRANTY
  50.  
  51.      This program is distributed on an "as-is" basis.  There are no
  52.      warranties expressed or implied.  In consideration of a license to use
  53.      this copyright program, the user accepts full responsibility for all
  54.      consequences of its use.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                     LICENSE
  62.  
  63.      This program may be distributed on magnetic media or by modem,
  64.      provided it is distributed in its complete and unaltered form.
  65.      "Unaltered form" does not preclude the use of well known library or
  66.      compression programs, as long as the files can be restored to their
  67.      original state.
  68.  
  69.  
  70.                                   INSTALLATION
  71.  
  72.      Installation consists of placing XChange.Exe and XChange.Cfg in some
  73.      directory accessible via your DOS PATH command.  Type, print, or use a
  74.      text editor to view the XChange.Cfg file.  It consists of several
  75.      groups of three lines.  Here is a sample of one such group:
  76.  
  77.           .ARC
  78.           >PKPAK    -NC -OT /A $N *.*
  79.           <PKUNPAK  $N *.*
  80.  
  81.      The first line starts with ".ARC".  This indicates that this
  82.      particular group applies to any file with the ".ARC" file type.
  83.  
  84.      The second line starts with ">", indicating the line refers to
  85.      inserting files into an ARC.  There are no spaces following the ">".
  86.  
  87.      The remainder of this line consists of the DOS command needed on your
  88.      system to insert files into an ARC.  The file name of the ARC will
  89.      replace the "$N".
  90.  
  91.      The third line is like the first, except that a "<" in the first
  92.      position indicates the line is used to extract files from an ARC.
  93.  
  94.      Additional control-line groups are used for each of the other
  95.      compression types to be supported.  The program supports up to 10
  96.      compression methods.
  97.  
  98.      Use a text editor to make any needed changes to the config file.  For
  99.      example, you may wish to alter the ARC section to use ARCE and ARCA:
  100.  
  101.           .ARC
  102.           >ARCA  $N *.*
  103.           <ARCE  $N *.*
  104.  
  105.      You may also add control lines to support addtional compression
  106.      methods, such as DWC.  XChange supports up to ten compression methods.
  107.  
  108.      All conversion programs used MUST return a zero return code for
  109.      successful completion and a non-zero return code in the event of any
  110.      errors.  PAK 1.0 does NOT meet these requirements.  A later version of
  111.      PAK should be used.
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.                                    OPERATION
  119.  
  120.      XChange [switches] <NewComp> [Filespec[/Filetype]]...');
  121.  
  122.      Switches may start with slash or hyphen:
  123.  
  124.           -S       Subdirectories searched
  125.           -N       Nested files are processed (e.g. ARCs within ARCs)
  126.           -K       Keep original file
  127.           -R       Repack files even if same type
  128.           -H       Halt on conversion error instead of skipping file
  129.           -Lfile   Log results to 'file' instead of StdOut
  130.           -Cfile   Configuration read from 'file' instead of XChange.Cfg
  131.  
  132.      <NewComp> is name of new compression method.  All eligible files will
  133.      be converted to this format.
  134.  
  135.      Filespec is a DOS file spec.  Wildcards are permitted.  The optional
  136.      Filetype forces the file to be processed as the specified type.
  137.  
  138.      Examples:
  139.  
  140.           o  XChange PAK *.ARC *.ZOO
  141.  
  142.              Convert all ARC and ZOO files to PAK files.  The original
  143.              files are deleted after conversion.
  144.  
  145.           o  XChange /K PAK *.ARC *.ZOO
  146.  
  147.              Same as the previous example, except the original files
  148.              are kept after conversion.
  149.  
  150.           o  XChange PAK *.SRC/ARC
  151.  
  152.              All SRC files will be treated as ARCs and converted to
  153.              PAK files.  The SRC files will be deleted and the
  154.              resulting files named PAK.  You may wish to rename the
  155.              files back to SRC after running XChange.
  156.  
  157.           o  XChange /S ZOO C:\*.ARC
  158.  
  159.              Convert all ARC files to ZOO.  Start with the root
  160.              directory of drive C: and search all subdirectories.
  161.  
  162.           o  XChange /N ZIP C:\FILES\OPUS*.ARC C:\FILES\OPUS*.ZOO
  163.  
  164.              Convert all ARC and ZOO files in C:\FILES to ZIP format.
  165.              Any nested files (ARC within ARC or ZOO within ZOO) will
  166.              also be converted.
  167.  
  168.  
  169.  
  170.  
  171.  
  172.           o  XChange /N /S PAK C:*.ARC C:*.ZOO C:*.ZIP -LD:XChange.Log
  173.  
  174.              Convert all ARC, ZOO and ZIP files in all directories of
  175.              drive C: to PAK format.  Summary information about the
  176.              conversion is written to D:XChange.Log.
  177.  
  178.  
  179.                         COMPLAINTS and SUGGESTIONS
  180.  
  181.      Send any complaints to NUL.  They won't be diginified with a
  182.      response.  Constructive suggestions can be sent to 1:135/990
  183.      until I get so fed up with Fight-O-Net that I drop my node
  184.      number.  At that point you can look for me in the EggNet nodelist
  185.      or glue a stamp to the back of a snail directed to:
  186.  
  187.              Scott Samet
  188.              PO Box 162082
  189.              Miami, FL 33116-2082
  190.  
  191.  
  192.  
  193.                                   HISTORY
  194.  
  195.      V1.03 03/18/88:
  196.              First general release